<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.sensor.ant.checkstyle;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.io.File;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.util.Date;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.util.HashMap;<a name="line.5"></a>
<FONT color="green">006</FONT>    import java.util.List;<a name="line.6"></a>
<FONT color="green">007</FONT>    import java.util.Map;<a name="line.7"></a>
<FONT color="green">008</FONT>    import java.util.Map.Entry;<a name="line.8"></a>
<FONT color="green">009</FONT>    <a name="line.9"></a>
<FONT color="green">010</FONT>    import javax.xml.bind.JAXBContext;<a name="line.10"></a>
<FONT color="green">011</FONT>    import javax.xml.bind.JAXBException;<a name="line.11"></a>
<FONT color="green">012</FONT>    import javax.xml.bind.Unmarshaller;<a name="line.12"></a>
<FONT color="green">013</FONT>    import javax.xml.datatype.XMLGregorianCalendar;<a name="line.13"></a>
<FONT color="green">014</FONT>    <a name="line.14"></a>
<FONT color="green">015</FONT>    import org.apache.tools.ant.BuildException;<a name="line.15"></a>
<FONT color="green">016</FONT>    import org.hackystat.sensor.ant.checkstyle.jaxb.Checkstyle;<a name="line.16"></a>
<FONT color="green">017</FONT>    import org.hackystat.sensor.ant.checkstyle.jaxb.Error;<a name="line.17"></a>
<FONT color="green">018</FONT>    import org.hackystat.sensor.ant.task.HackystatSensorTask;<a name="line.18"></a>
<FONT color="green">019</FONT>    import org.hackystat.sensor.ant.util.LongTimeConverter;<a name="line.19"></a>
<FONT color="green">020</FONT>    import org.hackystat.sensorshell.SensorShellException;<a name="line.20"></a>
<FONT color="green">021</FONT>    <a name="line.21"></a>
<FONT color="green">022</FONT>    /**<a name="line.22"></a>
<FONT color="green">023</FONT>     * Implements an Ant task that parses the XML files generated by Checkstyle. The Ant Task sends the<a name="line.23"></a>
<FONT color="green">024</FONT>     * CodeIssue data to a Hackystat server.<a name="line.24"></a>
<FONT color="green">025</FONT>     * <a name="line.25"></a>
<FONT color="green">026</FONT>     * @author Julie Ann Sakuda, Philip Johnson<a name="line.26"></a>
<FONT color="green">027</FONT>     */<a name="line.27"></a>
<FONT color="green">028</FONT>    public class CheckstyleSensor extends HackystatSensorTask {<a name="line.28"></a>
<FONT color="green">029</FONT>      <a name="line.29"></a>
<FONT color="green">030</FONT>      /** The type prefix for all attributes representing code issue errors. */<a name="line.30"></a>
<FONT color="green">031</FONT>      private static final String TYPE = "Type_";<a name="line.31"></a>
<FONT color="green">032</FONT>      /** The name of this tool. */<a name="line.32"></a>
<FONT color="green">033</FONT>      private static String tool = "Checkstyle";<a name="line.33"></a>
<FONT color="green">034</FONT>    <a name="line.34"></a>
<FONT color="green">035</FONT>      /** Initialize a new instance of a CheckstyleSensor. */<a name="line.35"></a>
<FONT color="green">036</FONT>      public CheckstyleSensor() {<a name="line.36"></a>
<FONT color="green">037</FONT>        super(tool);<a name="line.37"></a>
<FONT color="green">038</FONT>      }<a name="line.38"></a>
<FONT color="green">039</FONT>    <a name="line.39"></a>
<FONT color="green">040</FONT>      /**<a name="line.40"></a>
<FONT color="green">041</FONT>       * Initialize a new instance of a CheckstyleSensor for testing purposes.<a name="line.41"></a>
<FONT color="green">042</FONT>       * <a name="line.42"></a>
<FONT color="green">043</FONT>       * @param host The SensorBase host URL.<a name="line.43"></a>
<FONT color="green">044</FONT>       * @param email The SensorBase email to use.<a name="line.44"></a>
<FONT color="green">045</FONT>       * @param password The SensorBase password to use.<a name="line.45"></a>
<FONT color="green">046</FONT>       */<a name="line.46"></a>
<FONT color="green">047</FONT>      public CheckstyleSensor(String host, String email, String password) {<a name="line.47"></a>
<FONT color="green">048</FONT>        super(host, email, password, tool);<a name="line.48"></a>
<FONT color="green">049</FONT>      }<a name="line.49"></a>
<FONT color="green">050</FONT>    <a name="line.50"></a>
<FONT color="green">051</FONT>    <a name="line.51"></a>
<FONT color="green">052</FONT>      /**<a name="line.52"></a>
<FONT color="green">053</FONT>       * Parses the Checkstyle XML files and sends the resulting code issue results to the SensorBase<a name="line.53"></a>
<FONT color="green">054</FONT>       * server. <a name="line.54"></a>
<FONT color="green">055</FONT>       * <a name="line.55"></a>
<FONT color="green">056</FONT>       * @throws BuildException If there is an error.<a name="line.56"></a>
<FONT color="green">057</FONT>       */<a name="line.57"></a>
<FONT color="green">058</FONT>      @Override<a name="line.58"></a>
<FONT color="green">059</FONT>      public void executeInternal() throws BuildException {<a name="line.59"></a>
<FONT color="green">060</FONT>        setupSensorShell();<a name="line.60"></a>
<FONT color="green">061</FONT>    <a name="line.61"></a>
<FONT color="green">062</FONT>        int numberOfCodeIssues = 0;<a name="line.62"></a>
<FONT color="green">063</FONT>        Date startTime = new Date();<a name="line.63"></a>
<FONT color="green">064</FONT>        // Iterate though each file, extract the Checkstyle data, send to sensorshell.<a name="line.64"></a>
<FONT color="green">065</FONT>        for (File dataFile : getDataFiles()) {<a name="line.65"></a>
<FONT color="green">066</FONT>          verboseInfo("Processing Checkstyle file: " + dataFile);<a name="line.66"></a>
<FONT color="green">067</FONT>          try {<a name="line.67"></a>
<FONT color="green">068</FONT>            numberOfCodeIssues += this.processIssueXmlFile(dataFile);<a name="line.68"></a>
<FONT color="green">069</FONT>          }<a name="line.69"></a>
<FONT color="green">070</FONT>          catch (Exception e) {<a name="line.70"></a>
<FONT color="green">071</FONT>            signalError("Failure processing: " + dataFile, e);<a name="line.71"></a>
<FONT color="green">072</FONT>          }<a name="line.72"></a>
<FONT color="green">073</FONT>        }<a name="line.73"></a>
<FONT color="green">074</FONT>        this.sendAndQuit();<a name="line.74"></a>
<FONT color="green">075</FONT>        summaryInfo(startTime, "Checkstyle", numberOfCodeIssues);<a name="line.75"></a>
<FONT color="green">076</FONT>      }<a name="line.76"></a>
<FONT color="green">077</FONT>    <a name="line.77"></a>
<FONT color="green">078</FONT>      /**<a name="line.78"></a>
<FONT color="green">079</FONT>       * Parses a Checkstyle XML file and sends the code issue instances to the shell.<a name="line.79"></a>
<FONT color="green">080</FONT>       * <a name="line.80"></a>
<FONT color="green">081</FONT>       * @param xmlFile The XML file name to be processed.<a name="line.81"></a>
<FONT color="green">082</FONT>       * @return The number of issues that have been processed in this XML file.<a name="line.82"></a>
<FONT color="green">083</FONT>       * @exception BuildException thrown if it fails to process a file.<a name="line.83"></a>
<FONT color="green">084</FONT>       */<a name="line.84"></a>
<FONT color="green">085</FONT>      public int processIssueXmlFile(File xmlFile) throws BuildException {<a name="line.85"></a>
<FONT color="green">086</FONT>        XMLGregorianCalendar runtimeGregorian = LongTimeConverter.convertLongToGregorian(this.runtime);<a name="line.86"></a>
<FONT color="green">087</FONT>        try {<a name="line.87"></a>
<FONT color="green">088</FONT>          JAXBContext context = JAXBContext<a name="line.88"></a>
<FONT color="green">089</FONT>              .newInstance(org.hackystat.sensor.ant.checkstyle.jaxb.ObjectFactory.class);<a name="line.89"></a>
<FONT color="green">090</FONT>          Unmarshaller unmarshaller = context.createUnmarshaller();<a name="line.90"></a>
<FONT color="green">091</FONT>    <a name="line.91"></a>
<FONT color="green">092</FONT>          Checkstyle checkstyle = (Checkstyle) unmarshaller.unmarshal(xmlFile);<a name="line.92"></a>
<FONT color="green">093</FONT>          // list of file elements in the checkstyle result file<a name="line.93"></a>
<FONT color="green">094</FONT>          List&lt;org.hackystat.sensor.ant.checkstyle.jaxb.File&gt; checkedFiles = checkstyle<a name="line.94"></a>
<FONT color="green">095</FONT>              .getFile();<a name="line.95"></a>
<FONT color="green">096</FONT>          <a name="line.96"></a>
<FONT color="green">097</FONT>          int codeIssueCount = 0;<a name="line.97"></a>
<FONT color="green">098</FONT>          for (org.hackystat.sensor.ant.checkstyle.jaxb.File file : checkedFiles) {<a name="line.98"></a>
<FONT color="green">099</FONT>            // Fully qualified name of the file checked<a name="line.99"></a>
<FONT color="green">100</FONT>            String fileName = file.getName();<a name="line.100"></a>
<FONT color="green">101</FONT>    <a name="line.101"></a>
<FONT color="green">102</FONT>            // Base unique timestamp off of the runtime (which is when it start running)<a name="line.102"></a>
<FONT color="green">103</FONT>            long uniqueTstamp = this.tstampSet.getUniqueTstamp(this.runtime);<a name="line.103"></a>
<FONT color="green">104</FONT>    <a name="line.104"></a>
<FONT color="green">105</FONT>            // Get altered time as XMLGregorianCalendar<a name="line.105"></a>
<FONT color="green">106</FONT>            XMLGregorianCalendar uniqueTstampGregorian = LongTimeConverter<a name="line.106"></a>
<FONT color="green">107</FONT>                .convertLongToGregorian(uniqueTstamp);<a name="line.107"></a>
<FONT color="green">108</FONT>            <a name="line.108"></a>
<FONT color="green">109</FONT>            // Add required information to the sensor key-val map<a name="line.109"></a>
<FONT color="green">110</FONT>            Map&lt;String, String&gt; keyValMap = new HashMap&lt;String, String&gt;();<a name="line.110"></a>
<FONT color="green">111</FONT>            keyValMap.put("Tool", "Checkstyle");<a name="line.111"></a>
<FONT color="green">112</FONT>            keyValMap.put("SensorDataType", "CodeIssue");<a name="line.112"></a>
<FONT color="green">113</FONT>            keyValMap.put("Timestamp", uniqueTstampGregorian.toString());<a name="line.113"></a>
<FONT color="green">114</FONT>            keyValMap.put("Runtime", runtimeGregorian.toString());<a name="line.114"></a>
<FONT color="green">115</FONT>            keyValMap.put("Resource", fileName);<a name="line.115"></a>
<FONT color="green">116</FONT>            <a name="line.116"></a>
<FONT color="green">117</FONT>            Map&lt;String, Integer&gt; issueCounts = new HashMap&lt;String, Integer&gt;();<a name="line.117"></a>
<FONT color="green">118</FONT>            <a name="line.118"></a>
<FONT color="green">119</FONT>            // gets all error elements for the file<a name="line.119"></a>
<FONT color="green">120</FONT>            List&lt;Error&gt; errors = file.getError();<a name="line.120"></a>
<FONT color="green">121</FONT>            <a name="line.121"></a>
<FONT color="green">122</FONT>            // file has errors, send one entry per error<a name="line.122"></a>
<FONT color="green">123</FONT>            for (Error error : errors) {<a name="line.123"></a>
<FONT color="green">124</FONT>              String source = error.getSource();<a name="line.124"></a>
<FONT color="green">125</FONT>              <a name="line.125"></a>
<FONT color="green">126</FONT>              String[] tokens = source.split("\\.");<a name="line.126"></a>
<FONT color="green">127</FONT>              String rule = tokens[tokens.length - 1];<a name="line.127"></a>
<FONT color="green">128</FONT>              <a name="line.128"></a>
<FONT color="green">129</FONT>              if (issueCounts.containsKey(rule)) {<a name="line.129"></a>
<FONT color="green">130</FONT>                Integer count = issueCounts.get(rule);<a name="line.130"></a>
<FONT color="green">131</FONT>                issueCounts.put(rule, ++count);<a name="line.131"></a>
<FONT color="green">132</FONT>              }<a name="line.132"></a>
<FONT color="green">133</FONT>              else {<a name="line.133"></a>
<FONT color="green">134</FONT>                // no mapping, first occurrence<a name="line.134"></a>
<FONT color="green">135</FONT>                issueCounts.put(rule, 1);<a name="line.135"></a>
<FONT color="green">136</FONT>              }<a name="line.136"></a>
<FONT color="green">137</FONT>            }<a name="line.137"></a>
<FONT color="green">138</FONT>            <a name="line.138"></a>
<FONT color="green">139</FONT>            // Add the issue counts to the key-val map<a name="line.139"></a>
<FONT color="green">140</FONT>            for (Entry&lt;String, Integer&gt; entry : issueCounts.entrySet()) {<a name="line.140"></a>
<FONT color="green">141</FONT>              String typeKey = TYPE + entry.getKey();<a name="line.141"></a>
<FONT color="green">142</FONT>              keyValMap.put(typeKey, entry.getValue().toString());<a name="line.142"></a>
<FONT color="green">143</FONT>            }<a name="line.143"></a>
<FONT color="green">144</FONT>            <a name="line.144"></a>
<FONT color="green">145</FONT>            this.sensorShell.add(keyValMap);<a name="line.145"></a>
<FONT color="green">146</FONT>            codeIssueCount++;<a name="line.146"></a>
<FONT color="green">147</FONT>          }<a name="line.147"></a>
<FONT color="green">148</FONT>          return codeIssueCount;<a name="line.148"></a>
<FONT color="green">149</FONT>        }<a name="line.149"></a>
<FONT color="green">150</FONT>        catch (JAXBException e) {<a name="line.150"></a>
<FONT color="green">151</FONT>          throw new BuildException(errMsgPrefix + "Failure in JAXB " + xmlFile, e);<a name="line.151"></a>
<FONT color="green">152</FONT>        }<a name="line.152"></a>
<FONT color="green">153</FONT>        catch (SensorShellException f) {<a name="line.153"></a>
<FONT color="green">154</FONT>          throw new BuildException(errMsgPrefix + "Failure in SensorShell " + xmlFile, f);<a name="line.154"></a>
<FONT color="green">155</FONT>        }<a name="line.155"></a>
<FONT color="green">156</FONT>      }<a name="line.156"></a>
<FONT color="green">157</FONT>    }<a name="line.157"></a>




























































</PRE>
</BODY>
</HTML>
